口座振替オンライン申込 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様(.idPass)

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200:常に200を返却

BankAccountEntry 口座登録依頼

口座登録に必要な事項を送信し、以降の口座確認に必要なトランザクションIDを受け取ります。
※エンコードはShif_JISを使用してください。
金融機関コードごとに必須パラメータが異なります。
金融機関毎の必須パラメータについては口座振替オンライン申込 金融機関一覧を参照ください。

リクエスト
SiteID 必須 半角英数13桁
サイトID

SitePass 必須 半角英数64桁
サイトパスワード

MemberID 必須 半角英数記号60桁
会員ID

MemberName 全半角255バイト
会員名

CreateMember 必須 半角数字1桁 固定
会員作成フラグ

会員が存在しない場合の動作を指定します。
0:登録しない。
会員が存在しない場合、エラーを返す
1:登録する。
会員が存在しない場合、新規登録する

会員が存在する場合は、上記のいずれを指定されても問題ありません。

RetURL 必須 半角英数記号256桁
手続き後URL

申込手続き終了後、応答ページから遷移する加盟店様のURLです。

BankCode 必須 半角数字4桁

金融機関コード

金融機関コードは口座振替オンライン申込 金融機関一覧を参照ください。
信用金庫の場合は一律で金融機関コードに1000を設定ください。

BranchCode 半角数字3桁
支店コード

金融機関コードによって必須です。

AccountType 半角数字1桁 固定
預金区分

以下を設定してください。
1:普通
2:当座
金融機関コードによって必須です。

AccountNumber 半角数字7桁
口座番号

AccountName 全角英数カナ60桁
口座名義カナ

AccountNameKanji 全半角60バイト
口座名義

ConsumerDevice 必須 半角英字2桁
消費者利用端末

以下を設定してください。
pc:その他PC等(スマートフォン含む)

URL
/payment/BankAccountEntry.idPass
リクエストパラメータ
SiteID=tsite99887902&SitePass=PASSWORD&MemberID=memberid001&MemberName=会員名&CreateMember=1&RetURL=https://www.returl.sample.docs/ret.html&BankCode=0005&BranchCode=001&AccountType=1&AccountNumber=1234567&AccountName=コウザメイギ&AccountNameKanji=口座名義&ConsumerDevice=pc
レスポンス
正常
TranID 半角英数40桁 固定
トランザクションID

口座振替手続きのためのトランザクションIDです。

Token 半角英数記号108桁 固定
チェックトークン

URL遷移するために必要なチェックトークンです。

StartUrl 半角英数記号256桁
金融機関遷移URL

各金融機関で手続き開始するためのURLです。
お客様のブラウザに対して、このURLへのリダイレクトを送信してください。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
TranID=a6a6b0061347e10cdef805b39bd28705&Token=wpd8A+R8uWqt+GnF6auJtMZNSB4yzSCZR9xdztqdBjGwBS7yYvxSiC0zeMVH+O4F&StartUrl=https://example.com/payment/BankAccountStart.idPass
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

BankAccountStart 金融機関遷移

お客様を各金融機関の手続きページへ遷移させます。「金融機関遷移URL」に遷移するためのページを表示してください。

リクエスト
TranID 必須 半角英数40桁 固定
取引ID

Token 必須 半角英数記号108桁 固定
チェックトークン

リダイレクトページサンプル
<html>
      <head>
      <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
      </head>
      <body OnLoad='OnLoadEvent();'>
      <form name="SelectPageCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
        <noscript>
          <br>
          <br>
          <center>
            <h2> 金融機関に遷移します。ボタンをクリックしてください。</h2>
            <input type="submit" value="続行">
          </center>
        </noscript>
        <input type="hidden" name="TranID" value="{TranID}">
        <input type="hidden" name="Token" value="{Token}">
      </form>
      <script>
    <!--
    function OnLoadEvent() {
    document.SelectPageCall.submit();
    }
    //-->
      </script>
      </body>
    </html>

口座登録結果送信

口座登録手続きの完了報告を送信します。

レスポンス

レスポンスは以下の仕様で送信します。

Response header
Content-Type: text/plain;charset=windows-31j
文字コード
Shift_JIS
正常
TransactionID 半角英数記号40桁 固定
トランザクションID

SiteID 半角英数13桁
サイトID

MemberID 半角英数記号60桁
会員ID

Result 半角英字7桁
登録結果

SUCCESS:申込成功
PEND:保留
FAIL:申込失敗(金融機関からの登録NGとの結果が返却された状態)

BankCode 半角数字4桁
金融機関コード

金融機関コードは口座振替オンライン申込 金融機関一覧を参照ください。
信用金庫の場合は各金融機関コードが返却されます。

BranchCode 半角数字3桁
支店コード

ゆうちょ銀行(金融機関9900)の場合、預金記号の2-4桁目です。

AccountType 半角数字1桁 固定
預金区分

1:普通 2:当座

AccountNumber 半角数字8桁
口座番号

※ゆうちょ銀行(金融機関コード9900)の場合、預金番号となります。
※サイト設定の、「口座番号マスクレベル」により、*マスクされます。

AccountName 半角カナ60桁
口座名義人カナ

異常
ErrCode 半角英数3桁 固定
エラーコード

ErrDetail 半角英数9桁 固定
エラー詳細コード

※金融機関コード~口座番号の各項目について
登録結果がSUCCESSの場合のみ、設定されます。それ以外の場合、何も設定されません。

BankAccountTranResult 口座申込結果照会

申込結果を照会する。

リクエスト
SiteID 必須 半角英数13桁
サイトID

SitePass 必須 半角英数64桁
サイトパスワード

TranID 必須 半角英数40桁 固定
トランザクションID

結果を照会したい申込のトランザクションID

URL
/payment/BankAccountTranResult.idPass
リクエストパラメータ
SiteID=tsite99887902&SitePass=PASSWORD&TranID=123456789
レスポンス
正常
SiteID 半角英数13桁
サイトID

MemberID 半角英数記号60桁
会員ID

TranID 半角英数40桁 固定
トランザクションID

Status
登録結果

ENTRY:登録済み
START:金融機関画面遷移
TERM:結果確認
SUCCESS:申込成功
FAIL:申込失敗(金融機関からの登録NGとの結果が返却された場合の状態です。)
UNPROCESSED:申込失敗2(金融機関から結果が返却される以前に登録ができなかった場合の状態です。)

BankCode 半角数字4桁
金融機関コード

金融機関コードは口座振替オンライン申込 金融機関一覧を参照ください。
登録結果がSUCCESS以外の場合、信用金庫は一律で1000が返却されます。

BranchCode 半角数字3桁
支店コード

ゆうちょ銀行(金融機関9900)の場合、預金記号の2-4桁目となります。

AccountType 半角数字1桁 固定
預金区分

1:普通 2:当座

AccountNumber 半角数字8桁
口座番号

※ゆうちょ銀行(金融機関コード9900)の場合、預金番号となります。
※サイト設定の、「口座番号マスクレベル」により、*マスクされます。

AccountName 半角カナ60桁
口座名義人カナ

ErrCode 半角英数3桁 固定
エラーコード

ErrInfo 半角英数9桁 固定
エラー詳細コード

※金融機関コード~口座番号の各項目について
登録結果がSUCCESSの場合のみ、設定されます。それ以外の場合、何も設定されません。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
SiteID=tsite99887902&MemberID=memberid001&TranID=123456789&Status=SUCCESS&BankCode=0001&BranchCode=001&AccountType=1&AccountNumber=1234567&AccountName=コウザメイギ
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001

SearchMemberBankAccount 口座情報取得

登録されている口座情報を受け取ります。

リクエスト
SiteID 必須 半角英数13桁
サイトID

SitePass 必須 半角英数64桁
サイトパスワード

MemberID 必須 半角英数記号60桁
会員ID

URL
/payment/SearchMemberBankAccount.idPass
リクエストパラメータ
SiteID=tsite99887902&SitePass=PASSWORD&MemberID=memberid001
レスポンス
正常
SiteID 半角英数13桁
サイトID

MemberID 半角英数60桁
会員ID

BankCode 半角数字4桁
金融機関コード

ゆうちょ銀行の場合は"9900"が返却されます。

金融機関コードは口座振替オンライン申込 金融機関一覧を参照ください。
信用金庫の場合は各金融機関コードが返却されます。

BankName 全角45桁
金融機関名称

BranchCode 半角数字3桁
支店コード

※ゆうちょ銀行の場合、預金記号の2-4桁目となります。

BranchName 全角45桁
支店名称

AccountType 半角数字1桁 固定
預金区分

1:普通、2:当座
※ゆうちょ銀行の場合、ブランク

AccountNumber 半角数字8桁
口座番号

※ゆうちょ銀行の場合、預金番号の1-7桁目となります。
※サイト設定の、「口座番号マスクレベル」により、*マスクされます

AccountName 全角カナ60桁
口座名義人カナ

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ:正常系
SiteID=tsite99887902&MemberID=memberid001&BankCode=0038&BankName=住信SBIネット銀行&BranchCode=106&BranchName=法人第一支店&AccountType=1&AccountNumber=1234567&AccountName=ヤマダタロウ
レスポンスパラメータ:異常系
ErrCode=E01&ErrInfo=E01040001